
/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */


#include <ngx_config.h>
#include <ngx_core.h>


/*********************************************************************************************************************************************************
 *@brief: 创建一个动态数组
 *@para:  ngx_pool_t *p: 内存池
 *		  ngx_uint_t n: 预创建的动态数组元素个数
 *		  size_t size: 每个数组元素的大小
 *@return value: ngx_array_t *
 *********************************************************************************************************************************************************/
ngx_array_t * ngx_array_create(ngx_pool_t *p, ngx_uint_t n, size_t size)
{
    ngx_array_t *a;

    a = ngx_palloc(p, sizeof(ngx_array_t)); //创建一个动态数组的上下文 
    if (a == NULL) {
        return NULL;
    }
	//初始化这个动态数组
    if (ngx_array_init(a, p, n, size) != NGX_OK) {
        return NULL;
    }

    return a;
}

/*************************************************************************************************************************************************************
 *@brief:动态数组销毁 
 *@para:ngx_array_t *a: 动态数组上下文 
 *@return value:
 *************************************************************************************************************************************************************/
void ngx_array_destroy(ngx_array_t *a)
{
    ngx_pool_t  *p;

    p = a->pool; //找到动态数组对应的池

	//1.动态数组对应的存储区域是在本块内存池里
	
	//2.动态数组的上下文在本块内存里
	
	//在内存池中把内存块给回收了,通过指针的偏移来实现的
    if ((u_char *) a->elts + a->size * a->nalloc == p->d.last) {
        p->d.last -= a->size * a->nalloc;
    }

    if ((u_char *) a + sizeof(ngx_array_t) == p->d.last) {
        p->d.last = (u_char *) a;
    }
}


/*********************************************************************************************************************************************************
 *@brief:内存池的扩展 
 *@para: ngx_array_t *a:动态数组上下文 
 *@return value:
 ********************************************************************************************************************************************************/
void * ngx_array_push(ngx_array_t *a)
{
    void        *elt, *new;
    size_t       size;

    ngx_pool_t  *p;

    if (a->nelts == a->nalloc) {  //如果已经使用的元素个数等于数组的最大容量,说明满了

        /* the array is full */

        size = a->size * a->nalloc; //当前数组总的字节数 默认是当前容量乘以2

        p = a->pool; //对应的内存池

		//a->elts + size == p->d.last 保证了数组内存的连续性
		//p->d.last + a->size <= p->d.end 当前内存池中还有一个元素空间可以用
        if ((u_char *) a->elts + size == p->d.last && p->d.last + a->size <= p->d.end)
        {
            /*
             * the array allocation is the last in the pool
             * and there is space for new allocation
             */

            p->d.last += a->size;
            a->nalloc++;

        } else {
            /* allocate a new array */
			/*
			 *@如果当前的内存池已经不够的话,从新池进行申请
			 *
			 */
            new = ngx_palloc(p, 2 * size);
            if (new == NULL) {
                return NULL;
            }

            ngx_memcpy(new, a->elts, size);
            a->elts = new;
            a->nalloc *= 2;
        }
    }

    elt = (u_char *) a->elts + a->size * a->nelts;
    a->nelts++; //占有了一个元素空间

    return elt;
}


/*********************************************************************************************************************************************************
 *@brief:动态数组扩展 
 *@para:ngx_array_t *a: 动态数组的上下文  
 *		ngx_uint_t n: 要扩展的大小;
 *@return value:
 *********************************************************************************************************************************************************/
void * ngx_array_push_n(ngx_array_t *a, ngx_uint_t n)
{
    void        *elt, *new;
    size_t       size;
    ngx_uint_t   nalloc;
    ngx_pool_t  *p;

    size = n * a->size;  //想要扩展的内存块大小

	//如果a->nelts + n > a->nalloc 说明了当前占有的元素个数 + n > a->nalloc 
	//a->nalloc 是数组的最大容量 
    if (a->nelts + n > a->nalloc) {  

        /* the array is full */
        p = a->pool;  
		/*
		 *@ a->elts + a->size * a->nalloc  == p->d.last  说明了这个数组在这个内存块里是连续的
		 *@ p->d.last + size <= p->d.end 说明这个内存池剩余的空间足够 
		 *
		 */
        if ((u_char *) a->elts + a->size * a->nalloc == p->d.last && p->d.last + size <= p->d.end)
        {
            /*
             * the array allocation is the last in the pool
             * and there is space for new allocation
             */

            p->d.last += size;
            a->nalloc += n; //增加了n个内存 

        } else {
            /* allocate a new array */
            nalloc = 2 * ((n >= a->nalloc) ? n : a->nalloc); //
            new = ngx_palloc(p, nalloc * a->size); //申请新的内存块，
            if (new == NULL) {
                return NULL;
            }

            ngx_memcpy(new, a->elts, a->nelts * a->size); //这边原始内存块最后集中释放 
            a->elts = new;
            a->nalloc = nalloc;
        }
    }

    elt = (u_char *) a->elts + a->size * a->nelts;
    a->nelts += n;

    return elt;
}
